home *** CD-ROM | disk | FTP | other *** search
/ Graphics Plus / Graphics Plus.iso / msdos / raytrace / pov / gen / spiral22 / spiral22.doc < prev    next >
Text File  |  1992-01-11  |  14KB  |  320 lines
  1. │ SPIRAL v2.20               SPIRAL is a three dimensional coordinate generator.
  2. │ Copyright (C) 1992         SPIRAL creates output compatible for use with:
  3. │ By Truman Brown            * Connect The Dots Smoother (c) by Truman Brown
  4. │ Released:  01/12/92        * Vivid 1.0 (c) Raytracer by Stephen Coy
  5.  
  6. --------------------------------------------------------------------------------
  7.  
  8. STANDARD LEGAL INTRODUCTION AND REGISTRATION INFO:
  9.  
  10. SPIRAL is Freeware. No registration is required.
  11.  
  12. SPIRAL and its accompanying documentation are copyrighted material but
  13. may be freely copied and distributed for NONCOMMERCIAL use if:
  14. - Spiral and its documentation are distributed together.
  15. - No modifications are made to the program or its documentation.
  16.  
  17. If you desire to use SPIRAL for commercial usage, please contact the author
  18. for appropriate arrangements (see end of file for addressing).
  19.  
  20. Disclaimer:
  21. The author make no guarantees as to usability or suitability of the program.
  22. The author takes no responsibility for any effect the program may have on any
  23. system.  In other words, although SPIRAL has been tested as thoroughly as
  24. possible, USE IT AT YOUR RISK.
  25.  
  26. Enjoy.
  27.  
  28. --------------------------------------------------------------------------------
  29.  
  30. Spiral 2.2 is a major overhaul of publicly released version 1.1.
  31.  
  32. New features include:
  33.    * a configuration file
  34.    * ability to create "spiraling spirals"
  35.    * up to three rotations and/or translations of coordinates
  36.    * Vivid-compatible output with optional gradient surface definitions
  37.  
  38. --------------------------------------------------------------------------------
  39.  
  40. Like most simple utilities, the best way to figure it out is to simply jump
  41. right in and play with it.  However, for those that like to read documentation,
  42. here it is:
  43.  
  44. --------------------------------------------------------------------------------
  45.  
  46. USAGE: SPIRAL [/#] [/VI] [/Cfilename]
  47.  
  48. /#  = an optional precision value of decimal accuracy
  49.       Valid range is 0 to 10 decimal places
  50.       Default value is 3
  51. /VI = flag to generate Vivid output
  52.       Default is CTDS output
  53. /C  = flag to read input parameters from a configuration file [filename]
  54.  
  55.       Sorry, no spaces are allowed between the forward slashes and a parameter
  56.  
  57. --------------------------------------------------------------------------------
  58.  
  59. Depending upon the information that you provide SPIRAL, it will generate
  60. either CTDS- or Vivid-compatible output that describes the three dimensional
  61. coordinates of circular or spiral shapes.
  62.  
  63. While you can simply type SPIRAL at the DOS command line and get started, it is
  64. recommended that you use the configuration file method.  The configuration file
  65. provides an easy way to save the information required for creating a desired
  66. spiral, and also has several parameters not offered in the interactive mode.
  67.  
  68. NOTE:
  69. SPIRAL uses a left-hand XYZ coordinate reference.  X points positively to
  70. the right.  Y points positively up.  Z points positively into the screen.
  71. This coordinate system is the same as that used by the Persistance of
  72. Vision (PoV) raytracer (which CTDS supports).
  73.  
  74. This documentation follows the left-hand XYZ coordinate reference as described,
  75. therefore Vivid users should equate Y as Z, and Z as Y.
  76.  
  77. --------------------------------------------------------------------------------
  78.  
  79. INTERACTIVE MODE: (read this even if you are using the configuration file)
  80.  
  81. After typing "SPIRAL" followed by any command line parameter[s] except
  82. "/cfilename", Spiral will prompt you for the following information:
  83.  
  84. TYPE OF SPIRAL[S] TO GENERATE. THE OPTIONS ARE:
  85.     (1) Major spiral only,
  86.     (2) Minor spiral only, and
  87.     (3) Major and Minor spirals.
  88.  
  89.     A Major spiral is a basic spiral.
  90.     A Minor spiral is a spiral that wraps around a Major spiral.
  91.  
  92.     Option (1) will output the coordinates for your Major spiral to an ASCII
  93.     file called SPMAJOR.COR.
  94.  
  95.     Option (2) will output the coordinates for your Minor spiral to an ASCII
  96.     file called SPMINOR.COR.
  97.  
  98.     Option (3) will generate both SPMAJOR.COR and SPMINOR.COR.
  99.  
  100. DIRECTION THE MAJOR SPIRAL SPINS ON THE X-Z PLANE.
  101.     This information is required even if you are only generating a Minor spiral
  102.     (the Minor spiral needs to know everything about the shape of the Major
  103.     spiral it will be spinning around).
  104.  
  105.     Simply put - this prompt requests the direction the Major spiral will start
  106.     spinning, beginning on the ground and working its way up to the sky.
  107.  
  108.     Options are:
  109.     (1) Forward (counterclockwise) and
  110.     (2) Backward (clockwise)
  111.  
  112. BASE RADIUS OF THE MAJOR SPIRAL ON THE X-Z PLANE.
  113.     This information is required even if you are only generating a Minor spiral
  114.     (the Minor spiral needs to know everything about the shape of the Major
  115.     spiral it will be spinning around).
  116.  
  117.     This is the distance (radius) along the X axis from (0,0,0) to the first
  118.     coordinate of the Major spiral.  The first sphere is always plotted at
  119.     X=radius, Y=0, Z=0.
  120.  
  121.     The base radius must be greater than zero.
  122.  
  123. APEX RADIUS OF THE MAJOR SPIRAL ON THE X-Z PLANE.
  124.     This information is required even if you are only generating a Minor spiral
  125.     (the Minor spiral needs to know everything about the shape of the Major
  126.     spiral it will be spinning around).
  127.  
  128.     This is the distance (radius) from (X=0,Z=0) to the last coordinate of the
  129.     Major spiral.
  130.  
  131.     The apex radius must be greater than zero.
  132.  
  133. HEIGHT OF THE MAJOR SPIRAL ON THE X-Y PLANE.
  134.     This information is required even if you are only generating a Minor spiral
  135.     (the Minor spiral needs to know everything about the shape of the Major
  136.     spiral it will be spinning around).
  137.  
  138.     This is the distance from (0,0,0) to the tip of the spiral.
  139.  
  140.     The height may be any value (i.e., zero will create a ring).
  141.  
  142. RADIUS OF THE FIRST SPHERE OF THE MAJOR SPIRAL.
  143.     This is the radius of the first sphere at the beginning of the Major spiral.
  144.  
  145. RADIUS OF THE LAST SPHERE OF THE MAJOR SPIRAL.
  146.     This is the radius of the last sphere at the end of the Major spiral.
  147.  
  148. NUMBER OF REVOLUTIONS OF THE MAJOR SPIRAL.
  149.     This information is required even if you are only generating a Minor spiral
  150.     (the Minor spiral needs to know everything about the shape of the Major
  151.     spiral it will be spinning around).
  152.  
  153.     This is the number of times the Major spiral will make a full 360 degree
  154.     revolution about the Y axis.
  155.  
  156.     This value must be greater than zero, but may be non-integer (i.e., 3.4).
  157.  
  158. NUMBER OF SPHERES PER REVOLUTION OF MAJOR SPIRAL:
  159.     This is the number of coordinates to generate for each revolution of the
  160.     Major spiral.  If you are generating a spiral with non-integer revolutions,
  161.     remember that this value specifies the number of coordinates for a COMPLETE
  162.     (integer) revolution.  For example, if your number of revolutions is 0.5,
  163.     and you wanted 10 coordinates generated, you would need to specify 20 for
  164.     this prompt.
  165.  
  166.     This value must be an integer (whole number) and no less than 3.
  167.  
  168. If you selected options 2 or 3 from the first prompt (sphere_type = Minor, or
  169. Major and Minor), then you will see the following prompts:
  170.  
  171. DIRECTION THE MINOR SPIRAL SPINS ON THE X-Y PLANE.
  172.     This is the direction the Major spiral will start spinning, beginning on
  173.     the right side of the first sphere of the Major spiral and working its
  174.     way around right-to-left till it reaches the apex sphere of the Major
  175.     coordinate.
  176.  
  177.     Options are:
  178.     (1) Forward (counterclockwise) and
  179.     (2) Backward (clockwise)
  180.  
  181. BASE RADIUS OF THE MINOR SPIRAL ON THE X-Y PLANE.
  182.     This is the distance (radius) from the coordinate of the first sphere of
  183.     of the Major spiral to the first sphere of the Minor spiral.
  184.  
  185.     It is recommended that this value be greater than the radius of the
  186.     first sphere of the Major spiral, so that it will be visible.
  187.  
  188. APEX RADIUS OF THE MINOR SPIRAL ON THE X-Y PLANE.
  189.     This is the distance (radius) from the coordinate of the last sphere of
  190.     of the Major spiral to the last sphere of the Minor spiral.
  191.  
  192.     It is recommended that this value be greater than the radius of the
  193.     last sphere of the Major spiral, so that it will be visible.
  194.  
  195. RADIUS OF THE FIRST SPHERE OF THE MINOR SPIRAL.
  196.     This is the radius of the first sphere at the beginning of the Minor spiral.
  197.  
  198. RADIUS OF THE LAST SPHERE OF THE MINOR SPIRAL.
  199.     This is the radius of the last sphere at the end of the Minor spiral.
  200.  
  201. NUMBER OF REVOLUTIONS OF THE MINOR SPIRAL PER REVOLUTION OF MAJOR SPIRAL.
  202.     This is the number of times the Minor spiral will make a full 360 degree
  203.     revolution about the Major spiral for every revolution of Major spiral.
  204.  
  205.     This value must be greater than zero, but may be non-integer (i.e., 3.4).
  206.  
  207. NUMBER OF SPHERES PER REVOLUTION OF MINOR SPIRAL:
  208.     This is the number of coordinates to generate for each revolution of the
  209.     Minor spiral.
  210.  
  211.     This value must be an integer (whole number) and no less than 3.  Larger
  212.     values are recommended to avoid intersection with the Major spiral.
  213.  
  214. At this point, you have completed the minimal information required to generate
  215. the spiral coordinates.  The screen will show a summary of the values you have
  216. entered - if they are correct, then enter Y.  If not, enter N and the program
  217. will restart.
  218.  
  219. After the information has been verified, SPIRAL will prompt you for the number
  220. of coordinates to generate before inserting a blank line.  This value will
  221. determine how CTDS creates it's bounding spheres.  A common value would be
  222. 10.  This value is ignored for Vivid output.
  223.  
  224. --------------------------------------------------------------------------------
  225.  
  226. CONFIGURATION FILE USAGE:
  227.  
  228. If you entered SPIRAL /Cfilename at the command line, SPIRAL will read the
  229. configuration file "filename".  SPIRAL comes with a sample configuration file
  230. called SPIRAL.CFG.  You may simply edit SPIRAL.CFG, or copy it to another
  231. configuration filename.
  232.  
  233. WARNING:
  234.    DO NOT EDIT THE HEADER.  SPIRAL checks the configuration file for specific
  235.    information, including the header, to ensure that values will be read
  236.    correctly.
  237.    Additionally, DO NOT ADD OR DELETE any lines.  Simply overwrite the values
  238.    that currently exist.  With the exception of the first comment, you may
  239.    change or delete any comment to suit your taste.
  240.  
  241. The configuration file provides the benefit of being able to save all of the
  242. information regarding your spirals in a convenient file which can be easily
  243. modified.  It also provides additional parameters that are not available in
  244. the interactive mode.  These include:
  245.  
  246. OPTIONAL VIVID OUTPUT TYPE: (only recognized if /VI is used)
  247.     SPIRAL will generate two types of Vivid output:
  248.     (1) sphere definitions only.
  249.     (2) individual surface and sphere definitions.
  250.  
  251.     Selecting option (2) will allow you to graduate the various surface
  252.     parameters from the 1st sphere to the last sphere.  All basic Vivid 1.0
  253.     surface parameters are currently supported.  Look at the sample
  254.     configuration file for details.
  255.  
  256. 1ST X, Y, Z TRANSLATION OF SPIRALS
  257. 1ST X, Y, Z ROTATIONS OF SPIRALS
  258. 2ND X, Y, Z TRANSLATION OF SPIRALS
  259. 2ND X, Y, Z ROTATIONS OF SPIRALS
  260. 3RD X, Y, Z TRANSLATION OF SPIRALS
  261. 3RD X, Y, Z ROTATIONS OF SPIRALS
  262.     These options will allow you to translate and/or rotate the final spiral
  263.     coordinates up to three times.  Translations and rotations are performed
  264.     in sequence and alphabetically (i.e., X first, then Y, then Z).  As you
  265.     are aware, the sequence of rotations and translations is critical to the
  266.     final placement of a coordinate.  Therefore, carefully consider what the
  267.     transformation you are entering will do.
  268.  
  269. --------------------------------------------------------------------------------
  270.  
  271. If you did not select the /VI parameter on the command line, SPIRAL will
  272. generate a CTDS - compatible file.  To use it, enter a command similar to:
  273.  
  274.      CTDS /ISPMAJOR.COR /omyspiral.dat
  275.  
  276. If you did select the /VI parameter, then SPIRAL will generate usable Vivid
  277. data which you can simply copy into your .V file.
  278.  
  279. --------------------------------------------------------------------------------
  280.  
  281. HISTORY: (the life of a small program :} )
  282. ------------------------------------------
  283. 01/12/91: Spiral v2.2
  284. Code cleanup.
  285. Fixed bug in configuration file.
  286. Added gradiated Vivid surface options.
  287. Reworked documentation.
  288.  
  289. 01/02/91: Spiral v2.0
  290. Added Vivid-compatible output. Not released to public
  291.  
  292. 10/30/91: Spiral v1.5
  293. Added configuration file. Not released to public.
  294.  
  295. 09/19/91: Spiral v1.01
  296. No change whatsoever.  Released separately from CTDS.
  297.  
  298. 05/30/91: Spiral v1.00
  299. Cleaned up: 1st Official release
  300.  
  301. 04/01/91: Spiral v0.00
  302. SPIRAL (c) value generator written to test results of CTDS.
  303.  
  304. --------------------------------------------------------------------------------
  305.  
  306. Please address any bug-reports, comments, or desire to pay for SPIRAL (smile)
  307. to Truman Brown:
  308.  
  309.    COMPUSERVE: 71477,221  or
  310.    TR "The Graphics Alternative" (510) 524-2780 or
  311.    You Can Call Me Ray BBS (708) 358-5611 or
  312.    via ADENET.
  313.  
  314. --------------------------------------------------------------------------------
  315.  
  316. I wish to thank:
  317. My wife, for her patience and love.  Obsessed programmers/traceaholics can be
  318. miserable to live with.
  319.  
  320.